home *** CD-ROM | disk | FTP | other *** search
/ Freaks Macintosh Archive / Freaks Macintosh Archive.bin / Freaks Macintosh Archives / IRC / Bots⁄Utilities / ShadowBot10tr37.sit / SB10tr37 / Help < prev    next >
Text File  |  1996-08-31  |  12KB  |  522 lines
  1. 'ShadowBot 1.0 Help file, © 1996 John Bafford. All rights reserved.
  2. 'Help file format
  3. 'lines begining help entries:
  4. 'HELP <COMMAND> <INDEX> <NUMLINES>
  5. '<COMMAND> is the command name
  6. '<INDEX> is an index to the mainPrefs.al record that has the access level settings for ShadowBot. If <INDEX> is negative, then <INDEX> is the actual access level, otherwise it points to an access level in mainPrefs.al.
  7. '<NUMLINES> is the number of lines in the entry. When someone types !help <COMMAND>, the bot finds the offset of the first line of text and reads in <NUMLINES> of text.
  8. '"HELP" denotes the start of an entry. Avoid starting a line with "HELP".
  9. 'Each help entry takes approximately 40 bytes of RAM. You can create your own entries or modify or delete existing ones.
  10. 'One line of white space is not necessary between each entry, but it helps for clairity when manually viewing this file.
  11. 'The first line is the argument line. This MUST NOT be counted in <NUMLINES>.
  12.  
  13. HELP TOPICS 0 2
  14. Lists the command groupings for ShadowBot.
  15. Topics avalible: OPCHAT BASIC CHANNEL MISC USERS BOT MASS NOTES
  16. For more information, type !HELP TOPIC and the topic you want more info about.
  17.  
  18. HELP TOPIC_BOT 0 1
  19. These commands control bot modes.
  20. deaf hear sleep awake nick
  21.  
  22. HELP TOPIC_USERS 0 4
  23. These commands are userlist/shitlist matinence commands.
  24. infoline email whois
  25. add del userlist clvl cauto cprot
  26. shit rshit shitlist mshitlevel mshitdays mshit reason
  27. pass ident
  28.  
  29. HELP TOPIC_BASIC 0 2
  30. These are basic channel commands.
  31. k b ub up down op deop ping access version
  32. op deop kick k topic ban b unban ub up down +v -v
  33.  
  34. HELP TOPIC_OPCHAT 0 1
  35. Opchat does not work yet.
  36. opchat ctopic ckick clist cleave cecho
  37.  
  38. HELP TOPIC_CHANNEL 0 1
  39. These are other channel-related commands.
  40. join leave cycle invite mode listops listv spy rspy log
  41.  
  42. HELP TOPIC_MISC 0 2
  43. MIscelaneous commands
  44. ping time seen say msg notice me quit sign die
  45. country chat server rev raw stats saveall saveusers
  46. saveprefs saveshit idle changecc page cping rollcall send
  47.  
  48. HELP TOPIC_MASS 0 1
  49. Mass user commands.
  50. massop mop massdeop mdeop masskick mk massv mv massv- mv-
  51.  
  52. HELP TOPIC_NOTES 0 1
  53. These commands allow you to send notes to others on the bot.
  54. Type !HELP NOTES for more information.
  55.  
  56. HELP OP 1 1
  57. [nick]
  58. Ops the nick specified. If none specified, ops you.
  59.  
  60. HELP DEOP 2 1
  61. [nick]
  62. Deops the nick specified. If none specified, deops you.
  63.  
  64. HELP KICK 3 1
  65. [nick]
  66. Kicks the nick specified. If none specified, kicks you. (Also K)
  67.  
  68. HELP K 3 1
  69. [nick]
  70. Kicks the nick specified. If none specified, kicks you. (Also KICK)
  71.  
  72. HELP DIE 4 2
  73. [reason]
  74. Makes the bot write all files, signoff, and exit. Signs off with reason specified.
  75. If no reason, exits with the reason "!die requested"
  76.  
  77. HELP QUIT 4 1
  78. [reason]
  79. Same as DIE.
  80.  
  81. HELP SAY 5 1
  82. [text]
  83. Speaks text into the channel.
  84.  
  85. HELP MSG 6 1
  86. nick message
  87. Sends nick a message.
  88.  
  89. HELP NOTICE 7 1
  90. nick message
  91. Sends nick a notice
  92.  
  93. HELP ME 8 1
  94. action
  95. Does an action on the current channel.
  96.  
  97. HELP TIME 9 1
  98. [none]
  99. Displays the time.
  100.  
  101. HELP SEEN 10 1
  102. nick
  103. Displays the last time nick was seen and how long ago that was.
  104.  
  105. HELP ADD 11 3
  106. CHANNEL nick userAtHost accessLevel [autoOp] [prot] [pwd]
  107. Adds the user specified to the userlist. If no params past accessLevel are displayed, then they are set to off.
  108. If autoop is T, Y, or 1, autoop is enabled.
  109. Channel can either be a channel name or '*' (all of them).
  110.  
  111. HELP DEL 12 1
  112. channel mask
  113. Deletes a user matching the mask given on the channel specified.
  114.  
  115. HELP SAVEUSERS 13 1
  116. [none]
  117. Saves the userlist.
  118.  
  119. HELP SAVEPREFS 14 1
  120. [none]
  121. Saves the main preferences files.
  122.  
  123. HELP SAVESHIT 15 1
  124. [none]
  125. Saves the shitlist.
  126.  
  127. HELP SAVEALL 16 1
  128. [none]
  129. Saves all files.
  130.  
  131. HELP USERLIST 17 1
  132. [channel]
  133. Displays the userlist. If a channel is specified, the listing is limited to that channel only.
  134.  
  135. HELP BOTSTATS 18 1
  136. [none]
  137. Displays statistics about the bot. (Also STATS)
  138.  
  139. HELP STATS 18 1
  140. [none]
  141. Displays statistics about the bot. (Also BOTSTATS)
  142.  
  143. HELP CLVL 19 1
  144. channel nick access
  145. Changes a user in the userlist's access. You can not give someone more access than you have.
  146.  
  147. HELP CAUTO 20 1
  148. channel nick autoop
  149. Changes a user's autoop setting. If yours isn't on, you can't change theirs.
  150.  
  151. HELP ACCESS 21 1
  152. nick
  153. Views nick's access. If no nick is specified, your access is displayed.
  154.  
  155. HELP PING 22 1
  156. [none]
  157. Returns a pong response from the bot.
  158.  
  159. HELP PONG 22 1
  160. [none]
  161. Gag. Returns a ping respose from the bot.
  162.  
  163. HELP TOPIC 23 1
  164. topic
  165. Sets the topic of the channel.
  166.  
  167. HELP INFOLINE 24 1
  168. [infoline]
  169. Sets the text displayed when you join the channel. If you don't give an infoline, it displays yours.
  170.  
  171. HELP EMAIL 0 1
  172. [emailAddress]
  173. Sets your email address. If you don't give an address, it displays yours.
  174.  
  175. HELP IDLE 25 1
  176. idleSeconds
  177. Displays how long everyone the bot has seen is idle. If idleSeconds is present and greater than zero, displays those who have been idle longer than idleSeconds
  178.  
  179. HELP CHANGECC 26 1
  180. newCC
  181. Changes the bot's command character.
  182.  
  183. HELP PAGE 27 1
  184. [none]
  185. Pages the operator of the bot.
  186.  
  187. HELP UP 28 1
  188. [none]
  189. Ops you.
  190.  
  191. HELP DOWN 29 1
  192. [none]
  193. Deops you.
  194.  
  195. HELP BAN 30 1
  196. nickOrMask
  197. Bans, and then kicks, the mask of the nick passed to it, or the mask passed to it.
  198.  
  199. HELP B 30 1
  200. nickOrMask
  201. Same as BAN.
  202.  
  203. HELP UNBAN 31 1
  204. nickOrMask
  205. Unbans the nick or mask passed to it.
  206.  
  207. HELP UB 31 1
  208. nickOrMask
  209. Same as UNBAN.
  210.  
  211. HELP SHIT 32 4
  212. channel nickOrMask shitLevel days [reason]
  213. Shitlists the nick or mask passed to it for the number of days specified.
  214. See HELP SHITLEVEL for more information on the shitLevel parameter.
  215. Reason sets the reason seen in the SHITLIST and when the user is kicked from the channel.
  216. Channel can be either a channel or '*' (all of them).
  217.  
  218. HELP SHITLEVEL 0 6
  219. /not a command/
  220. SHITLEVEL =-1: automatic shitlist entry for flooding
  221. SHITLEVEL = 0: the user is not shitlisted
  222. SHITLEVEL = 1: the user is prevented from being opped
  223. SHITLEVEL = 2: the user is kicked on entry.
  224. SHITLEVEL = 3: the user is bankicked, unbanned five minutes later, and rebanned if he enters the channel; 
  225. SHITLEVEL = 4: the user is kickbanned; if he is unbanned, he is rebanned.
  226.  
  227. HELP UNSHIT 33 1
  228. channel nickOrMask
  229. Removes a nick or mask from the shitlist for a specific channel.
  230.  
  231. HELP RSHIT 33 1
  232. channel nickOrMask
  233. Same as UNSHIT.
  234.  
  235. HELP SHITLIST 34 1
  236. [channel]
  237. Displays the shitlist. Limits the listing to a specific channel if one specified.
  238.  
  239. HELP DEAF 35 1
  240. [none]
  241. Executes a MODE +d (prevents the server from sending channel messages).
  242.  
  243. HELP HEAR 36 1
  244. [none]
  245. Executes a MODE -d (allows channel messages to be recieved).
  246.  
  247. HELP SLEEP 37 1
  248. [none]
  249. Causes the bot to go to sleep, ignoring all commands except AWAKE.
  250.  
  251. HELP AWAKE 38 1
  252. [none]
  253. Wakes the bot.
  254.  
  255. HELP COUNTRY 39 1
  256. countryAbbrev
  257. Displays the full country name for the abbreviation passed to it.
  258.  
  259. HELP PLUSV 40 1
  260. [nick]
  261. Executes MODE +v on a nick. If no nick specified, operates on you.
  262.  
  263. HELP V 40 1
  264. [nick]
  265. Same as PLUSV
  266.  
  267. HELP +V 40 1
  268. [nick]
  269. Same as PLUSV
  270.  
  271. HELP V+ 40 1
  272. [nick]
  273. Same as PLUSV
  274.  
  275. HELP MINUSV 41 1
  276. [nick]
  277. Executes MODE -v on a nick. If no nick specified, operates on you.
  278.  
  279. HELP -V 41 1
  280. [nick]
  281. Same as MINUSV
  282.  
  283. HELP V- 41 1
  284. [nick]
  285. Same as MINUSV
  286.  
  287. HELP CHAT 42 1
  288. [none]
  289. Makes the bot DCC CHAT you.
  290.  
  291. HELP SERVER 43 1
  292. server [port]
  293. Changes servers.
  294.  
  295. HELP MSHITLEVEL 44 1
  296. channel nick|userAtHost newShitLevel
  297. Changes a user's shitlevel on specifiec channel.
  298.  
  299. HELP MSHITDAYS 45 1
  300. channel nick|userAtHost daysTillExpire
  301. Changes the number of days until the shitlist entry expires on specified channel.
  302.  
  303. HELP MSHITREASON 46 1
  304. nick|userAtHost newReason
  305. Changes the shitlist reason.
  306.  
  307. HELP CYCLE 47 1
  308. [seconds]
  309. Causes the bot to leave the current channel and rejoin seconds later. If seconds is zero or not present, the bot rejoins immediately.
  310.  
  311. HELP JOIN 48 1
  312. channel
  313. Makes the bot join a channel.
  314.  
  315. HELP LEAVE 49 1
  316. [channel]
  317. Makes the bot leave the channel, or current channel if none given.
  318.  
  319. HELP CPING 50 1
  320. [nick]
  321. Pings someone and tells you the ping time. If no nick is specified, the bot pings you.
  322.  
  323. HELP INVITE 51 1
  324. [nick]
  325. Invites someone to the channel. If no nick is specified, invites you.
  326.  
  327. HELP SEND 52 2
  328. nick filename
  329. DCC SENDs a file to someone. The file must be in the DCC folder.
  330. NOTE: When called from a script, this command does not care about access levels.
  331.  
  332. HELP NICK 53 1
  333. newnick
  334. Changes the bot's nick.
  335.  
  336. HELP WHOIS 54 1
  337. [nick]
  338. Gives information on someone in the userlist.
  339.  
  340. HELP CPROT 55 1
  341. nick protlevel
  342. Changes someone's protection level. You cannot set it higher than your own.
  343.  
  344. HELP REV 56 1
  345. text
  346. Reverses the text in the string passed to it.
  347.  
  348. HELP OPCHAT 57 1
  349. [none]
  350. Enters you into opchat.
  351.  
  352. HELP CTOPIC 58 1
  353. [topic]
  354. Displays the opchat topic or allows you to change it.
  355.  
  356. HELP CKICK 59 1
  357. [nick] [reason]
  358. Allows you to kick someone from opchat.
  359.  
  360. HELP CLIST 0 1
  361. [none]
  362. Lists the people in opchat.
  363.  
  364. HELP CLEAVE 0 1
  365. [reason]
  366. Allows you to leave opchat without closing your DCC connection to the bot.
  367.  
  368. HELP CECHO 0 1
  369. [none]
  370. Toggles the echo of text you type in OpChat.
  371.  
  372. HELP SIGNOFF 60 1
  373. [reason]
  374. Disconnects the bot from the server.
  375.  
  376. HELP SIGN 60 1
  377. [reason]
  378. Same as SIGNOFF.
  379.  
  380. HELP IGNORE 61 1
  381. /incomplete/
  382. Do not use this command.
  383.  
  384. HELP RAW 62 1
  385. rawIRC
  386. Sends anything you pass to it directly to the servr as-is.
  387.  
  388. HELP MODE 63 1
  389. channel rawMode
  390. Does raw mode changes.
  391.  
  392. HELP TOGOPS 64 1
  393. [channel] nick
  394. Does a MODE +o-o on nick.
  395.  
  396. HELP LISTOPS 65 1
  397. channel
  398. Lists the ops on the channel specified.
  399.  
  400. HELP LISTV 66 1
  401. channel
  402. Lists users that are +v on the channel specified.
  403.  
  404. HELP MASSOP 67 1
  405. [channel] mask
  406. Massops anyone on the channel matching the mask and not in the shitlist with a shitlevel > 0.
  407.  
  408. HELP MOP 67 1
  409. [channel] mask
  410. Massops anyone on the channel matching the mask and not in the shitlist with a shitlevel > 0.
  411.  
  412. HELP MASSDEOP 68 1
  413. [channel] mask
  414. Deops anyone on the channel matching the mask and not protected in the userlist.
  415.  
  416. HELP MDEOP 68 1
  417. [channel] mask
  418. Deops anyone on the channel matching the mask and not protected in the userlist.
  419.  
  420. HELP MASSKICK 69 1
  421. [channel] mask
  422. Kicks anyone in the channel mathcing the mask who doesn't have a protectlevel > 1.
  423.  
  424. HELP MK 69 1
  425. [channel] mask
  426. Kicks anyone in the channel mathcing the mask who doesn't have a protectlevel > 1.
  427.  
  428. HELP MASSV 70 1
  429. [channel] mask
  430. MODE +v's everyone on the channel matching the mask.
  431.  
  432. HELP MV 70 1
  433. [channel] mask
  434. MODE +v's everyone on the channel matching the mask.
  435.  
  436. HELP MASSV- 71 1
  437. [channel] mask
  438. MODE -v's anyone on the channel matching the mask.
  439.  
  440. HELP MV- 71 1
  441. [channel] mask
  442. MODE -v's anyone on the channel matching the mask.
  443.  
  444. HELP SPY 72 1
  445. channel
  446. Enables spy mode for the channel specified.
  447.  
  448. HELP CTCP 73 1
  449. text
  450. Initiates the CTCP command specified.
  451.  
  452. HELP LOG 0 2
  453. [channel] logCommand
  454. This command allows you to change the log settings. Type !HELP LOG cmd for more information.
  455. Valid commands are: ON, OFF, STATS, MARK. If no command is passed, STATS is assumed.
  456.  
  457. HELP LOG_ON 74 1
  458. LOG [channel] ON
  459. Turns logging on for the channel specified.
  460.  
  461. HELP LOG_OFF 75 1
  462. LOG [channel] OFF
  463. Turns logging off.
  464.  
  465. HELP LOG_STATS 76 1
  466. LOG [channel] STATS
  467. Gives the status of logging and the size of the log file.
  468.  
  469. HELP LOG_MARK 77 1
  470. LOG [channel] MARK text
  471. Makes a mark in the channel's log file.
  472.  
  473. HELP NOTE 0 0
  474. See !HELP NOTES
  475.  
  476. HELP NOTES 0 2
  477. These commands allow you to send notes to others on the bot.
  478. index read erase send
  479. Type !HELP NOTES and the command for information on each command.
  480.  
  481. HELP NOTES_INDEX 0 1
  482. [none]
  483. Displays all notes waiting for you.
  484.  
  485. HELP NOTES_READ 0 1
  486. [noteIndex]
  487. Displays all notes, or the specific note index you entered.
  488.  
  489. HELP NOTES_ERASE 
  490. noteIndex|"ALL"
  491. Erases a specific note, or type "ALL" (no quotes) to delete all.
  492.  
  493. HELP NOTES_SEND
  494. to message
  495. Sends a note.
  496.  
  497. HELP RSPY 0 1
  498. channel
  499. Removes a spy on the channel specified.
  500.  
  501. HELP IDENT 0 1
  502. [nick] password
  503. Allows the bot to recognize you if you have a password. Put a nick first if you want to gain access from a different u@h.
  504.  
  505. HELP PASS 0 2
  506. oldPassword newPassword [needPw]
  507. Changes your password. Pass 1 for needPw if you want the password required, otherwise set it to zero.
  508. Set your password to 'NONE' to clear it.
  509.  
  510. HELP PWD 0 1
  511. oldPassword newPassword [needPw]
  512. See !HELP PASS
  513.  
  514. HELP HELP 0 1
  515. command
  516. Displays help on a command. Type !HELP TOPICS for a list of topics.
  517.  
  518. HELP ROLLCALL 0 1
  519. [none]
  520. Identifies the bot as a ShadowBot, displays the version, owner, and, if you have access, the bot's command character.
  521.  
  522. END